Add EDOT references and tags across observability documentation #3862
Conversation
|
The note/tip is a good idea 👍 (we could even explicitly say that EDOT is the recommended way if that is ultimately why we're adding these, to not leave users wondering why we're suddenly mentioning this) On the other hand, I don't think we should be adding edot to the frontmatter's product list for cases where the only edot mention is that it can be used alternatively to what's described on the page (when the page itself isn't about edot or describing something using edot) |
|
@florent-leborgne Thanks for your input! You're right, we can be more explicit. As for the frontmatter, this was mentioned in the original (main) issue for this task, but maybe I did go a bit overboard 😄 |
benironside
left a comment
benironside
left a comment
There was a problem hiding this comment.
A couple of minor suggestions, but LGTM
solutions/observability/infra-and-hosts/get-started-with-system-metrics.md
Outdated
Show resolved
Hide resolved
bmorelli25
left a comment
bmorelli25
left a comment
There was a problem hiding this comment.
You link to this page: https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/3983/solutions/observability/apm/get-started but it references APM agents at the top of the page:
Elastic APM receives performance data from your APM agents, validates and processes it, and then transforms the data into Elasticsearch documents.
I think that line ⏫ should mention EDOT alongside APM agents (or just EDOT)
|
Can you also please add a disclaimer to the description of this Pull Request if you used AI to help with these changes. You can see an example in #3951. |
|
LGTM! Would love to get @mlunadia 's take on these updates. |
@bmorelli25 Right, I added the disclaimer to both PRs where I used AI. |
5 participants
This PR:
These changes aim to improve clarity and provide users with alternative solutions for telemetry data collection.
Part of #82
Closes #109
LLM usage disclosure: I prompted Claude 4.5 Sonnet in Cursor to find instances where EDOT mentions are missing (according to the issue description and internal conversations about this audit), then reviewed the content manually and fixed Vale linting issues.